Reads the scrap from the scrap file into memory.

OSStatus LoadScrap ();

function result

A result code.

DISCUSSION

The function allocates memory in your application’s heap to hold the scrap before reading the scrap into memory. The scrap file is located in the System Folder of the startup volume and has the filename as indicated by the scrapName field of the scrap information structure (usually “Clipboard”). If the scrap is already in memory, this function does nothing.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. Your application should not call this function at interrupt time.

AVAILABILITY

Not recommended in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.

CARBON NOTES

Carbon applications may continue calling this function on Mac OS 8; however, on Mac OS X it does nothing and is no longer necessary.

© 2000 Apple Computer, Inc. — (Last Updated 4/4/2000)